doc: Add pipeline guide#642
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #642 +/- ##
=======================================
Coverage 78.03% 78.03%
=======================================
Files 39 39
Lines 4685 4685
Branches 770 770
=======================================
Hits 3656 3656
Misses 720 720
Partials 309 309 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
|
||
| When a chain misbehaves, test each Tesseract in isolation first. A component you've verified on its own against a known input/output pair is a fixed point you can trust while debugging the workflow around it. |
There was a problem hiding this comment.
Maybe add a link to some docs on tesseract test or do you still feel this is too experimental.
| The one thing that makes or breaks chaining is at the _interface_, not the call site: a step composes cleanly with the next only if its output fields line up with the downstream input schema. Design for that. | ||
|
|
||
| ```{seealso} | ||
| [Designing good interfaces](design-patterns.md#designing-good-interfaces) — matching one Tesseract's `OutputSchema` to the next's `InputSchema` is what keeps chains readable. Design interfaces with the downstream consumer in mind. |
There was a problem hiding this comment.
Hmm, I'm not so keen on this, it feel a bit strong and prefer certain design patterns unnecessarily. The example above breaks this pattern (outputs from one Tesseract are used in another but that's it, the name changes, you still have to extract it, etc.
| ```bash | ||
| $ pip install cookiecutter | ||
| $ cookiecutter github:pasteurlabs/cookiecutter-tesseract | ||
| ``` |
There was a problem hiding this comment.
Can we give uv installation instruction as well/instead (see https://github.com/cookiecutter/cookiecutter)
2 participants
Adds a guide on how to build Tesseract-driven pipelines. References cookiecutter-tesseract (not public yet), so don't merge before that's live.